.. _Utility Functions:

=========================
Utility Functions
=========================

.. toctree::
   :maxdepth: 1
   :hidden:

.. note:: Utility functions are located in the ``UTIL.LUA`` file. 

.. warning:: These functions in ``UTIL.LUA`` must be included, as the game engine makes use of them and will likely crash if not found. Modifying them in an override ``UTIL.LUA`` is not recommended unless you know exactly what you are doing

+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| **Function**                                       | **Description**                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| addInfoEntry                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| addUserEntry                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| adjustItemGroup                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| autopickMageSpells                                 |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| buildJournalTable                                  |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| chapterText                                        |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| checkEntryComplete                                 |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| clearSessionsBefore                                |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| createEntry                                        |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| createObjective                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| createQuest                                        |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| currentCellCheck                                   |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| deepcopy                                           |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| displaySubtitles                                   |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| doneText                                           |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| fadeInOut                                          |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| filter                                             |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| findKeyNameById                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| findObjective                                      |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| findQuest                                          |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getBodyString                                      |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getDisplayQuestComplete                            |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getEntriesText                                     |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getFileNameStringRef                               |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getMinusFrame                                      |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getOpacityForInfoBlock                             |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getPlusFrame                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getStringFromAmbiguousSource                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getSubtitleString                                  |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getTitleString                                     |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getTitleText                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| getTooltipWithHotkey                               |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| greySidebars                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| highlightJournalButton                             |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| highlightString                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| inOutExpo                                          |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| incrChapter                                        |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| initLanguage                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| initQuestsOld                                      |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| keyExists                                          |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| length                                             |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| loadBinding                                        |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| minusButtonClickable                               |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| needsEscape                                        |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| plusButtonClickable                                |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| popSidebars                                        |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| popup2Button                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| popup3Button                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| popup4Button                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| popupDetails                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| popupInfo                                          |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| popupRequester                                     |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| printIni                                           |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| print_r                                            |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| processStringTokensLua                             |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| pushSidebars                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| quicksort                                          |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| removeJournalEntry                                 |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| removeStringTokenLua                               |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| removeUserEntry                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| resetScrollbar                                     |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| revertKeymap                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| setDoneState                                       |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| setKey                                             |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| setSelectedQuest                                   |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| setStringTokenLua                                  |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| showTextFlash                                      |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| sortByMageSpellName                                |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| sortByPriestSpellName                              |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| sortBySpellName                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| t                                                  |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| toggleDoneState                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| trim                                               |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| ungreySidebars                                     |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| uniqueFromTable                                    |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| updateDisplayEntries                               |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| updateDisplayJournal                               |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| updateDisplayTitles                                |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| updateJournalEntryOld                              |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+
| updateQuestState                                   |                                                                                             |
+----------------------------------------------------+---------------------------------------------------------------------------------------------+